Skip to content

#1627: Consolidated set command output and added support for quiet mode#1647

Open
bambu wants to merge 6 commits intomainfrom
1627-silence-settable
Open

#1627: Consolidated set command output and added support for quiet mode#1647
bambu wants to merge 6 commits intomainfrom
1627-silence-settable

Conversation

@bambu
Copy link
Copy Markdown
Contributor

@bambu bambu commented Apr 23, 2026 •
edited by tleonhardt
Loading

Description

Improve user experience of the set command by consolidating output into 1 line and allowing for the output to be hidden when quiet is set. The previous output was overly verbose (three lines) and could not be silenced.

Changes

  • Consolidated Output: The set command now produces a clean, single-line confirmation instead of the previous three-line format.
  • Colorized Diffs: The old value is displayed in red and the new value in green, providing a clear visual diff of the change.
  • Quiet Mode Support: Switched the output from poutput() to pfeedback(). This allows the set command's change confirmation to be silenced entirely when the quiet settable is enabled, while remaining noisy by default.
  • Unit Tests: Updated tests/test_cmd2.py and tests/test_commandset.py

Example Behavior

   # Default behavior (noisy, consolidated, colorized)
   (CLI)> set timing True
   timing: False -> True

   # Silent when quiet mode is enabled
   (CLI)> set quiet True
   (CLI)> set timing False
   # (No output produced)

Closes #1627

bambu added 3 commits April 22, 2026 09:48
@bambu
Silenced the set command on success by default and consolidated its o…
438ef95 
…utput. (#1627)

* Made the set command silent on success by default.
* Added a -v/--verbose flag to the set command to display change confirmations.
* Consolidated the verbose output into a single, colorized line (e.g., param: old -> new).
* Updated unit tests to reflect the new default behavior and output format.
@bambu
Changed set command output unless quiet mode is enabled.
45f17c4 
* Updated do_set to use pfeedback for change confirmations, allowing it to be silenced via the quiet setting.
* Updated unit tests to match the new output format and verify quiet mode behavior.
@bambu
Merge branch 'main' into 1627-silence-settable
58a3aa4
@bambu bambu self-assigned this Apr 23, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 23, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.51%. Comparing base (a3890a7) to head (70480ab).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1647      +/-   ##
==========================================
+ Coverage   99.49%   99.51%   +0.02%     
==========================================
  Files          21       21              
  Lines        4741     4742       +1     
==========================================
+ Hits         4717     4719       +2     
+ Misses         24       23       -1
Flag Coverage Δ
unittests 99.51% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kmvanbrunt
Copy link
Copy Markdown
Member

kmvanbrunt commented Apr 23, 2026

@bambu I need to consider this. I don't think the previous output was too verbose. I'm OK if we reformat it, but the amount of information displayed was, in my view, reasonable.

I'm also concerned about the new output being on one line. A settable could be anything, including an entire command line to run a tool. If we are still going to display both the previous and new value, I think they need to be on separate lines.

Help me understand the reason behind this change. Are you running set a lot in scripts and seeing a lot of output or something?

tleonhardt
tleonhardt reviewed Apr 23, 2026
View reviewed changes
Comment thread cmd2/cmd2.py
@tleonhardt
Merge branch 'main' into 1627-silence-settable
9bcb78c
@tleonhardt
Merge branch 'main' into 1627-silence-settable
7287681
@tleonhardt
Attempt at a compromise format that is split over 2 lines
70480ab 
New format looks like:

```sh
myapp> set allow_style always
allow_style: 'Terminal'
          -> 'Always'
```

Where "'Terminal'" is red and "'Always'" is green.

This is still more abbreviated than the original format, but not as abbreviated as putting everything on one line. Moreover, it preserves the more colorful diff-style display and the switch to using pfeedback.
@tleonhardt
Copy link
Copy Markdown
Member

tleonhardt commented Apr 27, 2026 •
edited
Loading

@bambu @kmvanbrunt
I pushed a change which is a compromise which attempts to preserve the intent of the change in this PR but address the concerns brought up. Below is an image of what the new format looks like.

Screenshot 2026-04-27 at 11 38 18 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tleonhardt tleonhardt tleonhardt left review comments

@kmvanbrunt kmvanbrunt Awaiting requested review from kmvanbrunt kmvanbrunt is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@bambu bambu

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Settable output is overly verbose and lacks a silent mode

3 participants

@bambu @kmvanbrunt @tleonhardt